home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / cdsub44.zip / CDSUB.DOC < prev    next >
Text File  |  1993-03-23  |  18KB  |  366 lines
  1.  
  2.                                   CD SUB 4.4
  3.                                   ==========
  4.  
  5.         One of the Livewire Collection of multi-BBS Doorware programs.
  6.            Supporting PCBoard, Wildcat!, Gap, QBBS, RBBS, Spitfire,
  7.           UltraBBS, Telegard, TriTel, TriBBS, Remote Access, and WWIV
  8.  
  9.                                   Written By
  10.  
  11.                                 Richard Paquette
  12.                                    PO Box 416
  13.                               Mt. Laurel, NJ 08054
  14.                               (C)Copyright 1990/93
  15.                                All Rights Reserved
  16.  
  17.                  DOOR DESCRIPTION!
  18.  
  19.  CD Sub is a very simple door... it allows players to guess two numbers, we
  20.  randomly spin for two numbers, if they match the players guessed numbers,
  21.  then the player wins a SIX MONTH (6 issues) subscription FREE to the only
  22.  BBS Magazine available for Callers... The BBS Callers Digest.
  23.  
  24.  If the player doesn't match the two numbers, then he/she is asked if they
  25.  would like to subscribe to the magazine using their Visa/MasterCard. 
  26.  
  27.  Please upload your ORDER.DAT file as often as there are entries.. so that
  28.  we can process the orders.. when you register this door.. you get a free
  29.  listing in the authorized CDSUB BBS List which will appear in the print
  30.  BBS Callers Digest each month along with the electronic version.
  31.  
  32.  Please name the zip file with order.dat according to your registration
  33.  number.. for example if your reg number is 123456, then please name the
  34.  zip 123456.zip... "pkzip 123456 order.dat" would be the command to use.
  35.  
  36.  When you upload the 123456.ZIP file to The Livewire BBS, please mark the
  37.  file PRIVATE with a forward slash / in front of the description. 
  38.  
  39.  If the player decides to download the order form to send in with his
  40.  check or money order.. he MUST include the name of the BBS he/she got
  41.  the order form from in order for us to remit your commissions to you.
  42.  
  43.  If you have already registered a door program from "Livewire Doors" then
  44.  you have access already to all node numbers, if not then you can call
  45.  609-235-5297 to register CD Sub... because if the door isn't registered
  46.  NO ORDER.DAT file will be created. Any FREE subscription winners WILL NOT
  47.  be supported...
  48.  
  49.            *** SPECIAL NOTICE TO ALL REGISTERED SYSOPS! ***
  50.  
  51.  When this door is registered, your BBS name and access number will be
  52.  listed in BBS Callers Digest as an authorized BBS to order subscriptions
  53.  online. This "FREE" listing will be appended in each monthly copy of the
  54.  BBS Callers Digest Magazine.
  55.  
  56.                                    FILES
  57.  
  58.                The following files are packaged with CD SUB
  59.  
  60.  cdsub.exe      <--- executable program must be in directory at all times
  61.  cdsub.cfg      <--- sample configuration file, must have one for each node
  62.  cdsub          <--- Sample batch file to call up door program
  63.  cdsub.doc      <--- What you are reading right now (includes order form)
  64.  history.doc    <--- History of door versions
  65.  order.dat      <--- Created if not there.. To be uploaded to us often
  66.  bbscd.log      <--- Created if not there.. shows who downloaded order form
  67.  bbscd.frm      <--- Order form that is downloadable from within the door
  68.                      PLEASE DO NOT delete this file.. the door WILL NOT
  69.                      operate correctly. PLEASE DO NOT EDIT THIS FILE EITHER!
  70.  order.frm      <--- Order form for all Livewire Doors
  71.  
  72.  PLEASE remember to upload us the ORDER.DAT file, it may contain names of any
  73.  winners in the door or credit card subscriptions... we cannot remit to you
  74.  unless we have the order.dat file!
  75.  
  76.  NOTE PLEASE: We have used PKLite on the Executable file and if you have any
  77.               problems, please let us know as soon as possible. Thanks
  78.  
  79.                       Example Configuration for CD Sub
  80.  
  81.         c:\pcb\users.sys         <=- Full name of your systems file (see below)
  82.         The Livewire BBS         <=- Full name of your BBS
  83.         Richard                  <=- Full first name of Sysop
  84.         Paquette                 <=- Full last name of Sysop
  85.         123456                   <=- Your reg number (Something must be here!)
  86.         3                        <=- Number of times caller can use door today
  87.  
  88. IMPORTANT NOTE!! (Please Read Me!)
  89.  
  90.   We have tested the routine that controls how many times the door can be
  91.   used in any 24 hour period, but it will sometimes NOT allow the player 
  92.   in on the next day.. if that should occur... just delete the CDSUB.USR
  93.   file, the program will create a new one.
  94.  
  95.   As a matter of fact, we suggest that you delete the file each night in
  96.   your nightly event with a command similiar to the following:
  97.  
  98.      --> if exist c:\cdsub\cdsub.usr del c:\cdsub\cdsub.usr  <--
  99.  
  100.   You can now take advantage of the PCBoard set variables in Board.bat.. if you
  101.   want to use them.. this door will read them.. 
  102.  
  103.   NOTE:  You must have DSZ in the your path somewhere for callers to be able to
  104.   download the order form.
  105.  
  106. GENERAL CONFIGURATION EXAMPLES
  107.  
  108.         EXAMPLE CONFIGURATION FILE FOR PCBOARD.SYS
  109.         ------------------------------------------
  110.  
  111.         C:\PCB\PCBOARD.SYS  <=-  (Full pathname of your PCBOARD.SYS file)
  112.         The Livewire BBS    <=-  (Change this to your BBS name)
  113.         Richard             <=-  (The Sysop's first name)
  114.         Paquette            <=-  (The Sysop's last name)
  115.  
  116.         EXAMPLE CONFIGURATION FILE FOR USERS.SYS
  117.         ------------------------------------------
  118.  
  119.         C:\PCB\USERS.SYS    <=-  (Full pathname of your USERS.SYS file)
  120.         The Livewire BBS    <=-  (Change this to your BBS name)
  121.         Richard             <=-  (The Sysop's first name)
  122.         Paquette            <=-  (The Sysop's last name)
  123.  
  124.         EXAMPLE CONFIGURATION FILE FOR DOOR.SYS
  125.         ---------------------------------------
  126.  
  127.         C:\BBS\DOOR.SYS     <=-  (Full pathname of your DOOR.SYS file)
  128.         The Livewire BBS    <=-  (Change this to your BBS name)
  129.         Richard             <=-  (The Sysop's first name)
  130.         Paquette            <=-  (The Sysop's last name)
  131.  
  132.         EXAMPLE CONFIGURATION FILE FOR CALLINFO.BBS
  133.         -------------------------------------------
  134.  
  135.         C:\BBS\CALLINFO.BBS <=-  (Full pathname of your CALLINFO.BBS file)
  136.         The Livewire BBS    <=-  (Change this to your BBS name)
  137.         Richard             <=-  (The Sysop's first name)
  138.         Paquette            <=-  (The Sysop's last name)
  139.  
  140.         EXAMPLE CONFIGURATION FILE FOR DORINFOx.DEF
  141.         -------------------------------------------
  142.  
  143.         C:\BBS\DORINFOx.DEF <=-  (Full pathname of your DORINFOx.DEF file
  144.                                   where 'x' is the BBS Node number.
  145.         The Livewire BBS    <=-  (Change this to your BBS name)
  146.         Richard             <=-  (The Sysop's first name)
  147.         Paquette            <=-  (The Sysop's last name)
  148.  
  149.         EXAMPLE CONFIGURATION FILE FOR SFDOORS.DAT
  150.         ------------------------------------------
  151.  
  152.         C:\BBS\SFDOORS.DAT  <=-  (Full pathname of your SFDOORS.DAT file)
  153.         The Livewire BBS    <=-  (Change this to your BBS name)
  154.         Richard             <=-  (The Sysop's first name)
  155.         Paquette            <=-  (The Sysop's last name)
  156.  
  157.         EXAMPLE CONFIGURATION FILE FOR CHAIN.TXT
  158.         ----------------------------------------
  159.  
  160.         C:\BBS\CHAIN.TXT    <=-  (Full pathname of your CHAIN.TXT file)
  161.         The Livewire BBSS   <=-  (Change this to your BBS name)
  162.         Richard             <=-  (The Sysop's first name)
  163.         Paquette            <=-  (The Sysop's last name)
  164.  
  165.                     Example configuration file for GTUSER.BBS
  166.                      ----------------------------------------
  167.                                                                              
  168.         C:\BBS\GTUSER.BBS   <=-  (Full pathname of your GTUSER.BBS file)
  169.         The Livewire BBS    <=-  (Change this to your BBS name)
  170.         Richard             <=-  (The Sysop's first name)
  171.         Paquette            <=-  (The Sysop's last name)
  172.         1                   <=-  (COM port number - defaults to 1) 
  173.         1                   <=-  (Node number - defaults to 1)
  174.         123123              <=-  (Registration Number)
  175.  
  176.                     Example configuration file for TRIBBS.SYS
  177.                      ----------------------------------------
  178.                                                                              
  179.         C:\BBS\TRIBBS.SYS   <=-  (Full pathname of your TRIBBS.SYS file)
  180.         The Livewire BBS    <=-  (Change this to your BBS name)
  181.         Richard             <=-  (The Sysop's first name)
  182.         Paquette            <=-  (The Sysop's last name)
  183.  
  184.                               ==============
  185.  
  186.                             CD Sub BATCH FILE
  187.  
  188. This is the batch file whose name is entered in PCBSETUP. It should reside in
  189. your default PCB directory. Leave this as is except for changing the paths.
  190.  
  191.           ECHO OFF
  192.           C:
  193.           CD\CDSUB
  194.           CDSUB CDSUB.CFG  <--- Please read NOTE below
  195.           C:
  196.           CD\PCB
  197.           IF EXIST EVENT.BAT EVENT          
  198.           BOARD
  199.  
  200.   NOTE: This door is multi-node capable and the requirement is to have a
  201.         different CD Sub.cfg passed on the batch file command line, such as:
  202.             CDSub CDSub1.cfg * CDSub CDSub2.cfg * CDSub CDSub3.cfg!
  203.  
  204.  
  205. IMPORTANT NOTE FOR FOSSIL DRIVERS:
  206.  
  207.  CdSub now includes support for FOSSIL drivers!!! This means your Doors
  208.  will work with multi-ports (e.g. PCBoard's/M version) and other multi-port
  209.  boards. To activate the Fossil driver support, just include /FD on the
  210.  command line when running the Door. For example:
  211.  
  212.  cdsub cdsub.cfg /fd
  213.  
  214.  If no Fossil driver is available, CdSub will display a message to that
  215.  effect and exit gracefully.
  216.  
  217.                      ------------------------------------
  218.  
  219. Example Batch File 
  220. -------------------
  221. A sample batch file is included and is similar to the following:
  222.    ECHO OFF
  223.    CD\DOORS                <=- Switch to the door's Directory.
  224.    DOOR DOOR.CNF           <=- Execute the door program and pass the
  225.                                 configuration filename to the program.
  226.    CD\PCB                  <=- Go back to PCB DIR when user exits door.
  227.    BOARD                   <=- Restart BBS.
  228.                                                                              
  229. This Door is multi-node  compatible so you may run more than 1 node from
  230. the same .CNF file  provided the path to your system file (DORINFOx.DEF,
  231. CALLINFO.BBS, etc) is exactly the same unless you are using environment
  232. variables, (q.v.)
  233.  
  234.                          Environment Variables
  235.  
  236. PCBoard automatically creates the %PCBDRIVE% & %PCBDIR% environment
  237. variables. Non-PCBoard systems may also use these variables by including
  238. the following in either your BBS batch or AUTOEXEC.BAT
  239.  
  240.   SET PCBDRIVE=C:               <- Drive letter of your BBS files
  241.   SET PCBDIR=\BBSDIR            <- Path to your BBS files
  242.  
  243. Then in your Door .CNF file instead of putting C:\BBSDIR\DOOR.SYS, you
  244. would put %PCBDRIVE%%PCBDIR%\DOOR.SYS. This allows you to use just one
  245. .CNF file for multi-node operation!
  246.                                                                              
  247. To specify a non-standard IRQ, put the IRQ number after the .CNF on the
  248. command line.  For example:
  249.                                                                              
  250.      DOOR DOOR.CNF /5
  251.      or using the PCBDRIVE procedure: SET IRQ=5 and use
  252.      DOOR DOOR.CNF /%IRQ%  
  253.                                                                              
  254. This tells the program to use IRQ 5 instead of the standard IRQ.
  255.  
  256.                            Top Ten Bulletin
  257.                            ----------------
  258.                                                                              
  259. The first time you run this door online it will create 3 files called
  260. ****.BUL, ****.BLT and ****.BLT. If you  wish to change the path
  261. or filename of the  Bulletin,  you must edit  ****.BUL and  change the
  262. first line to whatever path/filename you desire, assuming that this door
  263. requires or has a bulletin to display.. these docs are generic for all
  264. The Livewire Doors and some of them DO NOT create a bulletin.
  265.  
  266.                               Sysop Keys
  267.                               ----------
  268.  
  269. F3    -  Toggles the printer On/Off. Value is passed to PCBoard and/or
  270.          written to DOOR.SYS and USERS.SYS
  271. F4    -  Toggles the Page Bell on/off. Value is passed to PCBoard
  272.          and/or written to DOOR.SYS and USERS.SYS
  273. F5    -  DOS Shell. Allows SysOp to exit to DOS from inside a DOOR.
  274. F7    -  Toggles the Caller Alarm On/Off. Value is passed to PCBoard
  275.          and/or written to DOOR.SYS and USERS.SYS
  276. F8    -  Returns the caller involuntarily to the BBS.
  277. F9    -  Toggles the local display On/Off. Value is passed to PCBoard
  278.          and/or written to DOOR.SYS and USERS.SYS
  279. F10   -  Activates SysOp CHAT mode within the DOOR.
  280. ESC   -  Deactivates CHAT mode.  DOOR is resumed.
  281. UP    -  Give the caller extra time while in the DOOR.  
  282. DN    -  Subtract time from the caller while in the DOOR. 
  283. HOME  -  HELP key for Status Line options.
  284. ALT-N -  SysOp next on toggle. Value passed to PCBoard. (PCBoard only)
  285. ALT-X -  PCBoard will exit after current caller logs off. Value is
  286.          passed to PCBoard. Not available on non-PCBoard systems.
  287.  
  288.                              Distribution
  289.                              ------------
  290.                                                                              
  291. This program is being distributed via the SHAREWARE concept and as such,
  292. may be copied freely with the following restrictions:
  293.                                                                              
  294.         * The program must be supplied in it's original unmodified
  295.           form, including documentation.
  296.                                                                              
  297.         * This program may not be distributed as part of any commercial
  298.           application or service without the express, written consent
  299.           of the author.
  300.                                                                              
  301.         * Vendors of Shareware/Public Domain software may not
  302.           distribute this program without the express, written
  303.           consent of the author even if Vendor has been approved
  304.           by the Association of Shareware Professionals (ASP).
  305.  
  306.                              Registration
  307.                              ------------
  308.                                                                              
  309. This door represents  many hours of  programming and the author deserves
  310. just compensation for his time, efforts and expertise.  If you find this
  311. program to be of some  value and you  continue to use it on your system,
  312. you must return the order form provided along with the registration fee.
  313. Registration  entitles you to  free upgrades via  modem from  The Livewire
  314. BBS Support Conference.  Payments should be  made in the  form of a check or
  315. money order. Foreign orders must be in U.S. funds drawn on a U.S. bank.
  316.  
  317. Online registration with Visa or Mastercard is available via our Credit
  318. Card Door at the following system:
  319.                                                                              
  320.                   The Livewire BBS: (609) 235-5297 HST
  321.                                                                              
  322. NOTE: If you register by mail,  your registration number will be posted
  323.       in a private message on The Livewire BBS. 
  324.  
  325.                                Copyright
  326.                                ---------
  327.                                                                              
  328. This door is Copyrighted(c) 1989-93 by Richard Paquette, and is distributed
  329. as Shareware. Under this concept you may use the SHAREWARE (unregistered)
  330. version for a  reasonable period of  time for evaluation  after which you
  331. must either register your copy or discontinue  usage.
  332.  
  333.                                Warranty
  334.                                --------
  335.                                                                              
  336. This product is provided as is without warranty of any kind.  The entire
  337. risk as to the results and performance of the program is assumed by you.
  338. Futhermore, the  author does not warrant, guarantee, or  make any  other
  339. representations regarding the use of,  or the  results of the use of the
  340. program,  and you rely on the  program and  results  solely at  your own
  341. risk.  The author  cannot and will not accept  responsibility for system
  342. damage, loss of profit or any other special, consequential or incidental 
  343. damages  resulting  from  the use of or inability to  use this  product.
  344.  
  345.                                Com-Ports
  346.                                ---------
  347.  
  348.                    DoorFrame now supports COM 0 thru 15.
  349.  
  350.                              Fossil Drivers
  351.                              --------------
  352.                                                                              
  353. This door may be used with Fossil drivers such as X00 & BNU.  This makes
  354. it compatible  with most  multi-port  boards.  To use the Fossil  driver
  355. instead of the standard COM ports, include  /FD on the command line when
  356. running the door. For example: DOOR DOOR.CNF /FD
  357.  
  358.  
  359.                               WATCHDOG/CTTY
  360.                               -------------
  361.  
  362. CTTY and WATCHDOG are not required and should not be used with this program.
  363. CD Sub contains its own communication routines which monitor the COM port.  
  364. If carrier is lost, it will return to the BBS and log the user off the system.
  365.  
  366.